home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1996 Christmas / macformat-045.iso / Shareware Central / AllDay 5.0 / AllDay / Instructions < prev    next >
Encoding:
Text File  |  1996-07-20  |  13.4 KB  |  296 lines  |  [TEXT/ttxt]

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19. This document contains the following sections
  20. Version 5.0, July 20, 1996
  21.  
  22.      • What is AllDay?
  23.          • Calendar Computation and Display
  24.          • Preferences
  25.      • Colors
  26.      • Holidays
  27.      • User Events
  28.      • Day Popup Menu
  29.      • AppleScript
  30.      • About Development
  31.      • System Requirements
  32.      • Installation
  33.      • Legal Stuff
  34.      • Version History
  35.      • Credits & Special Thanks
  36.  
  37.  
  38.  
  39. What is AllDay?
  40.  
  41. AllDay is an application for display of a yearly calendar. It computes and shows any years within the Julian and Gregorian calendar systems (see separate "About Calendars..." document). Also, it calculates the number of week in three different ways, the number of day in year and the number of remaining days in year.
  42.  
  43. A year can be displayed in either horizontal or vertical orientation; i.e., weekdays appear either next to each other or beneath each other. Weekdays are ordered starting with either Sundays or Mondays. And the application is bilingual, running either in German or in English.
  44.  
  45. AllDay computes up to 30 holidays and allows for adding any amount of other yearly recurring events (user events).
  46.  
  47. Activated holidays and user events (see below) can be displayed in separate list windows.
  48.  
  49.  
  50. Calendar Computation and Display
  51.  
  52. While early versions of AllDay were based on calendar routines of the operating system, the application now works completely independent from the MacOS in terms of computing its calendars.
  53.  
  54. Although the MacOS has almost everything built in, there are missing some essential calendar abilities like holidays, week number (only US version available), and as well the whole Julian calendar system.
  55.  
  56. AllDay therefore uses basic calendar and holiday algorithms as they are also built into several operating systems. I collected these algorithms from various sources during the continuing effort of extending AllDay's features. As a result I developed my own universal C library of date utilities which is also built into AllDay.
  57.  
  58. While the algorithms are commonly available ways of computation, which were developed and published partly centuries ago already, the universal C library and certainly its functionality coming to life inside of AllDay are my own product of development.
  59.  
  60. The code of the mentioned C library is not availble to the public, however, its full functionality is separately available through my AppleScript extension (OSAX) "DatePack". DatePack extends AppleScript with all commands necessary to make full use of all functions of the library thus porting all of its features to the whole MacOS and all applications.
  61.  
  62. Computation of calendar data an its display is extremely fast due to a specially designed technique of transferring calendar data to a colored picture. This allows for a fast change of years as well as switch of other settings like language, orientation of weekdays or calendar system.
  63.  
  64.  
  65. Preferences
  66.  
  67. A preferences window allows for individual settings.
  68.  
  69. Besides display of weekdays and starting day of week, the way of computing week numbers and the calendar system (Julian or Gregorian) can be chosen. The program works in either English or German language.
  70.  
  71. Highlighting of holidays, user events and today's date can be switched on and off separately.
  72.  
  73. As with Mac desk accessories (DAs) it can be chosen whether or not closing all windows quits the application.
  74.  
  75. All settings are saved along with the last window positions in a preferences file (file "AllDay Prefs" in "Preferences" folder of system folder).
  76.  
  77.  
  78. Holidays
  79.  
  80. AllDay knows 30 holidays which can be indiviually switched on for display through a separate configuration window. Such holidays are highlighted in the yearly overview.
  81.  
  82. Computation of holidays is 'hard coded' and cannot be changed. For additional holidays user events can be used (see below).
  83.  
  84.  
  85. Colors
  86.  
  87. Through another configuration window individual color settings can be chosen. Upon click on one of its color rectangles the Apple Color Picker is shown to allow the change of color. Foreground and background color of sundays, holidays, user events and today's date can be set.
  88.  
  89.  
  90. User Events
  91.  
  92. In addition to holidays AllDay allows to enter user specific events thus enabling display of birthdays for example. Such events can be entered as holidays or as plain user events. User events are as well marked in the yearly overview.
  93.  
  94. Display of either date or week events are possible. A date events would be a birthday, for example recurring on October 16 each year. Week events instead incur each year on the same day of the same week of the same month, like the third wednesday in November for example.
  95.  
  96. Double clicking a day in the yearly overview brings up a window for entering a new user event. Upon choice of a user event from the popup menu which appears when clicking a day in the yearly overview (see below), a window for changing the chosen user event is shown.
  97.  
  98. User events are saved in a separate data document through the normal 'Open' and 'Save' functions.
  99.  
  100.  
  101. Popup Menu for Day Details
  102.  
  103. By clicking and holding the mouse button while pointing to a day in the yearly overview  the user can watch the day's details in a popup menu.
  104.  
  105. The menu contains the date in long notation, week number, number of days gone since January 1 and the number of days from the chosen day until the end of the year. All activated user events and holidays for this day are also shown in the menu.
  106.  
  107. Upon choice of a user event from the menu the window for changing the selected user event is shown.
  108.  
  109.  
  110. AppleScript
  111.  
  112. AllDay supports AppleScript through the "Required Event Suite" including commands "Run", "Open", "Print" and "Quit".
  113.  
  114. Two other commands complete AllDay's AppleScript functionality. "getDayEvents" lists all event names for a given day. "isHoliday" tests whether a given day is a holiday.
  115.  
  116. For all AppleScript commands example scripts are available including a simple alarm function.
  117.  
  118. Additional goodies for AppleScripters: All algorithms used in AllDay are availble separately through my AppleScript extension (OSAX) "DatePack". DatePack extends AppleScript and thus the whol Macintosh system by respective commands and is available online as separate freeware package. Common sources include CompuServe (GO MACHYP) and the Internet (http://hyperarchive.lcs.mit.edu/HyperArchive.html).
  119.  
  120.  
  121. About Development
  122.  
  123. AllDay has been developed using Symantec Think C. For documentation Symantec Think Reference (very good!) and the "Inside Macintosh" CD ROM by Apple have been used.
  124.  
  125.  
  126. System Requirements
  127.  
  128. This version of AllDay should run on any Macintosh with an MC68020 or later CPU and System 7 or higher. It supports 32-Bit Color QuickDraw.
  129.  
  130. AllDay ppc runs on any Power Macintosh with at least PPC 601 processor.
  131.  
  132.  
  133. Installation
  134.  
  135. Just copy the Folder "AllDay 5.0" to your hard disk, then double-click the AllDay icon to start the application.
  136.  
  137. For ready access, it is suggested to create an alias of the data document that contains your user events. Place it into your Apple Menu Folder and rename the alias to "AllDay". Whenever AllDay is chosen from your Apple Menu, AllDay is started and the user events document is opened.
  138.  
  139. If you have used an earlier version of AllDay, this version will rebuild the "Preferences" file, using default settings from the newer version.
  140.  
  141. CAUTION: When switching from any 68k version to any PPC version for the first time, the old "Preferences" file has to be removed manually. User events documents cannot be exchanged between 68k- and PPC versions.
  142.  
  143.  
  144. Legal Stuff
  145.  
  146. This product is Freeware. Any commercial use (sale, publication etc.) is not allowed. Publication in magazines is welcome at any time. When sharing AllDay, the application and all of its additional documents must remain unchanged, i.e. please share only the original package. Please contact me when in doubt:
  147.  
  148.             Ulrich Hilger
  149.             Avrillestrasse 5
  150.             65824 Schwalbach
  151.             Germany
  152.  
  153.             CompuServe 100116,2751
  154.             e-Mail 100116.2751@compuserve.com
  155.  
  156. Please do let me know of any incompatibility you might encounter — this will help me to provide maximum stability in any future version(s) of AllDay.
  157.  
  158.  
  159. Version History
  160.  
  161. Version 5.0 (20.7.1996)
  162. *    A new AppleScript command "isHoliday" checks, whether a certain day
  163.         is a holiday.
  164. *    Calendar display now works for any year.
  165. *    Kalendar system can be changed between "Gregorian" and "Julian" (see
  166.         separate document 'About Calendars').
  167. *    Computation of week number can be switched to three different
  168.         county specific settings.
  169. *    Display of long date in day popup menu is now correct for any year.
  170. *    Display of number of day has been enhanced in the day popup menu
  171. *    English and German documentation has been improved.
  172.  
  173. Version 4.6 (3/24/1996)
  174. *    New AppleScript command "getDayEvents" allows retrieval of all events
  175.         of a given day. A new example script "Get Events" demonstrates this new
  176.         feature with a simple alarm function.
  177. *    Double clicking a day in the yearly overview brings up the window for
  178.         adding a new user event.
  179. *    Choosing a user event from the day popup menu shows the window for
  180.         changing the chosen user event.
  181. *    Attribute "show" is on by default when adding a new user event.
  182.  
  183. Version 4.5 (2/14/96)
  184. *    A german/french version of AllDay now exists due to the translation efforts of
  185.         Christophe Laporte
  186.  
  187. Version 4.5 (1/14/96)
  188. *    User events are shown either as holidays or user events (color)
  189. *    In the 68k Version, the long date is now shown correctly when bringing up a popup
  190.         menu by clicking on a day in the yearly overview.
  191.  
  192. Version 4.4 (12/31/95)
  193. *    The holiday popup menu has been extended to show information on any selected
  194.         day. It additionally contains long date, week number, number of days until the
  195.         chosen day and number of days from the chosen day until the end of the year.
  196. *    AllDay is scriptable through AppleScript. The "Required Event Suite" (run,
  197.         open, print, quit) has been implemented.
  198. *    With AllDay ppc published in parallel, a native PPC version is available.
  199.  
  200. Version 4.3 (11/25/95)
  201. * Repentance Day ist now displayed correctly.
  202. * All holidays and user events are being displayed in the respective pop up menu
  203.    instead of just the first of one day's holidays and user events.
  204.  
  205. Version 4.2 (8/14/94)
  206. * Does not crash anymore upon choice of "Show User Events" menuoption while
  207.    32 bit addressing is on
  208.  
  209. Version 4.1 (4/23/94)
  210. * When clicked in the yearly overview a marked day's name is shown in
  211.    a popup window
  212. * The Program now knows 30 public holidays
  213. * Preferences folder is recognized on Systems other than US or German
  214. * Menus that open windows are as well showing the window again when
  215.    the window is hidden behind others
  216. * Popup-Menus in the dialog for configuration of user events meet
  217.    Apple User Interface Guidelines
  218. * Configuration dialog are now modeless. Window positions are stored
  219.    in the preferences file
  220. * Popup-Menus in the dialog for configuration of user events are dimmed
  221.    according to the chosen event type
  222. * Contains default colors
  223. * Corrects some bugs of v4.0 regarding addition of user events, window and
  224.    file management
  225.  
  226. Version 4.0 (3/6/94)
  227. *    Introduces date and week type user events
  228. *    Allows to choose a separate color for display of user events in the
  229.         yearly overview
  230. *    New preferences dialog
  231. *    Holidays and user events are displayed in independently scrollable
  232.         and sizeable windows
  233. *    User can choose whether or not the application quits upon close of
  234.         all windows
  235. *    Prints user events together with holidays
  236.  
  237. Version 3.1 (12/18/93)
  238. *    Corrects some typos in the documentation and AllDay´s "About"-Dialog and
  239.         in the documentation
  240. *    Contains a smaller holiday menu
  241. *    Allows printing through the standard print dialog
  242. *    Marks today's date
  243. *    Allows to change foreground- and background colors of sundays, holidays
  244.         and today's date
  245. *    Knows four new holidays (now 22)
  246. *    Routines that need Color-Quickdraw are called on Quickdraw-Macs only
  247. *    Needs only half of the RAM amont needed by version 3.0
  248.  
  249. Version 3.0 (11/7/93)
  250. *    Stores window positions in the "Preferences"-file as well
  251. *    Can now compute weekdays of years outside the range of the clock chip
  252. *    Knows up to 18 different public holidays
  253. *    Lists up to 18 holidays in a separate window
  254. *    Allows you to configure the holiday list through a separate dialog
  255. *    Marks chosen holidays in yearly overview
  256. *    Stores holiday settings in the "Preferences"-file
  257. *    Holiday functions are now accessible through new menu
  258. *    Version 3.0 is now Freeware
  259.  
  260. Version 2.3 (8/13/93)
  261. *    Corrects a memory management bug
  262. *    Stores current settings in a "Prefs" file within the 
  263.     System´s "Preferences" folder
  264.  
  265. Version 2.1 (4/12/93)
  266. *    Sundays will be drawn in red on Macs with 32-Bit Color
  267.         QuickDraw.
  268.  
  269. Version 2.0 (4/11/93)
  270. *    Calendar window remembers its position during most recent 
  271.     session
  272. *    New "Change" menu
  273. *    Options for browsing and "Change Year" are now contained in the
  274.         "Change" menu
  275. *    Buttons at the bottom of the screen have been removed
  276. *    Choice of horizontal or vertical orientation for weekdays is now
  277.         available through "Change" menu
  278. *    Calendar table now is completely generated offscreen and then 
  279.         copied onto the screen, providing faster screen updates
  280. *    Menu-choice of Sunday or Monday as the starting day for each week
  281. *    Menu-choice of English- or German-language calendar
  282.  
  283. Version 1.3 (3/8/93)
  284. *    Corrects some major bugs of Version 1.2
  285.  
  286. Version 1.2 (2/13/93)
  287. *    Initial publication
  288.  
  289.  
  290. Credits & Special Thanks
  291.  
  292. Special thanks to my wife Simone for her acceptance of my "computer liaison".
  293.  
  294. A huge "Thank you!" to Steve Maller for his help and experience on debugging AllDay version 1.3 and to Christophe Laporte for his translation to french.
  295.  
  296. Thanks also to all the people who sent their comments for the sake of enhancing AllDay.